home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / rbrain.zip / ROMBRAIN.DOC < prev    next >
Text File  |  1992-04-26  |  13KB  |  312 lines
  1. April, 1992
  2.                                                                      1.
  3.  
  4.  
  5.  
  6.  
  7.                                   ROMBRAIN
  8.                      (C) Copyright 1992 by Stanley Sheff
  9.                        Support BBS: The Brainex System
  10.                                (310) 275-2344
  11.                                (310) 273-5234
  12.    CDROM File Door for NIGHT OWL, RBBS-IN-A-BOX, GRAB BAG, So Much Shareware
  13.                                ---------------
  14.  
  15.    Welcome to the RomBrain. Now your callers can access your CDROM drive
  16.    without having to use your BBS's file system.  This door works with
  17.    GAP, PCBoard, Wildcat, Spitfire, WWIV, and RBBS, as well as any BBS that
  18.    generates a DOOR.SYS file when running a door.  RomBrain is a multi-user
  19.    door and requires SHARE.EXE and DOS 3.3 or above.  RomBrain writes user's
  20.    download stats to DOOR.SYS for BBSes that read this back in to update
  21.    user information.  
  22.    
  23.    RomBrain requires the program DSZ.COM or DSZ.EXE in the path.
  24.    If you have an unregistered DSZ, Y-Modem G protocol will NOT function.
  25.    
  26.    Here's what the RomBrain can do:
  27.  
  28.    Supports IBM ANSI Color and plain text mode (ASCII) 
  29.    for your callers who don't use IBM characters or don't use ANSI.
  30.    
  31.    RomBrain supports com ports opened up to 115,200 and as 
  32.    many of them as you can fit in the machine. This makes RomBrain easy 
  33.    to set up on a multi-node system with GAP. RomBrain will also 
  34.    support several other BBSes by the use of conversion programs available 
  35.    nearly everywhere.
  36.     
  37.    RomBrain creates an index file from information stored on your CD.
  38.    The file uses about a megabyte of disk space.   
  39.  
  40.    Menu Functions:
  41.  
  42.    [F]ile Directory
  43.    Allows you to select one of the CD ROM directories.  Once you've 
  44.    selected a directory, you may:
  45.  
  46.    [D]ownload file(s)
  47.    You can add names to a list of files for download.  The list
  48.    may be edited.  If you use Xmodem Protocol, each file will
  49.    be sent one at a time, and you will be asked if you wish to
  50.    continue receiving files from the list.
  51.  
  52.    [M]ark a file 
  53.    Add the file name entered to a list to be downloaded later.
  54.    Just type the letter shown to the left of the filename. 
  55.  
  56.                                                                      2.
  57.  
  58.    [A]rchive
  59.    View contents of a .ZIP file, Read a file from within the .ZIP file,
  60.    Transfer (Download) a file from within the .ZIP file, or Download 
  61.    the entire .ZIP file.
  62.  
  63.    [S]earch for text within the directory.  You may enter all or any
  64.    part of a word for a search.  This function searches filename, date,
  65.    and description. Selected word will be highlighted in red for color
  66.    or <brackets> for monochrome.
  67.  
  68.    The above commands are available from the Main Menu as well as the
  69.    Directory Menu.
  70.  
  71.   *NOTE: When asked to enter a file name, .ZIP will be added automatically
  72.          if you do not include an extender.  
  73.  
  74.  
  75.     RomBrain Files
  76.     ----------------
  77.     ROMBRAIN.EXE <------------------ RomBrain Program
  78.     ROMBRAIN.DOC <------------------ Sysop's Information
  79.     REGISTER.DOC <------------------ Registration information
  80.     SETUP.EXE    <------------------ Setup / Initializer Program
  81.     COMPILE.EXE  <------------------ Filebase Creator
  82.     HELP         <------------------ General Help File
  83.     CDHELP       <------------------ Download Help File
  84.     WELCOME      <------------------ ASCII Welcome Screen     
  85.     WELCOMEG     <------------------ ANSI Welcome Screen
  86.     RBRAIN.SCR   <------------------ Rombrain Data File
  87.     EXTSX.BAT    <------------------ Batch File to call DSZ Xmodem
  88.     EXTS1.BAT    <------------------ Batch File to call DSZ Xmodem/1K
  89.     EXTSY.BAT    <------------------ Batch File to call DSZ Ymodem
  90.     EXTSZ.BAT    <------------------ Batch File to call DSZ Zmodem
  91.     EXTSF.BAT    <------------------ Batch File to call DSZ Xmodem/1K-G
  92.     EXTSG.BAT    <------------------ Batch File to call DSZ Ymodem-G
  93.     NEWSTUFF.DOC <------------------ Update Information
  94.  
  95.    All of these files should be in this ZIP, if they are not, don't
  96.    take a chance! Call The Brainex System and get a good copy or view the 
  97.    file on a few local boards to see if you can find a complete copy.
  98.  
  99.    RomBrain handles all of its file transfers from within the door.
  100.    A set of predefined protocol batch files are included for use with
  101.    the DSZ protocol engine. Parameters are passed to the protocol batch
  102.    files in the following order:
  103.    
  104.         %1 - Communications port
  105.         %2 - Baud rate
  106.         %3 - File name to send
  107.  
  108.                                                                      3.
  109.    SETUP
  110.    =====
  111.    The setup of RomBrain is simple, all you need to do is create a
  112.    directory called ROMBRAIN for RomBrain and its files, then copy the
  113.    files into that directory. After that you will need to run the SETUP
  114.    program to create a config file and a CDROM file base.
  115.  
  116.    1. Be sure you have the CD you are going to use inserted into your
  117.       CDROM drive.
  118.  
  119.    2. From the ROMBRAIN directory, type SETUP.
  120.  
  121.    3. Fill in all the required information.
  122.  
  123.    4. Save the configuration with the [W]rite option.
  124.  
  125.    5. Use the [C]ompile option to create a filebase for your disk.
  126.  
  127.    * NOTE * RomBrain supports these CDs: Night Owl, So Much Shareware,
  128.             RBBS in a Box, Shareware Grab Bag, Storm-1.  Ready made
  129.             file bases are available for download from Brainex BBS.
  130.  
  131.    6. The Compiler will automatically read required information from
  132.       your CD and create a filebase in the directory indicated by the
  133.       SETUP program.
  134.  
  135. When SETUP is complete...
  136.  
  137.    If you like, you may edit the file CDTYPE_x.4 to customize category names.
  138.    The "x" will be substituted for CD type. Ex. CDTYPE_A.4 is for type A,
  139.    CARRS Night Owl CD.
  140.  
  141.    The Setup program will create the following files:
  142.  
  143.    RBRAINx.CNF  x=node number
  144.  
  145.    CDTYPE_x.1
  146.    CDTYPE_x.2
  147.    CDTYPE_x.3
  148.    CDTYPE_x.4  (ASCII file of category names.  Edit this for accuracy!)
  149.  
  150.    The file directory menu is generated internally by the RomBrain,
  151.    but if you wish to use a customized menu, just create your own menu
  152.    and name it MENUx for ASCII and MENUxG for ANSI.  "x" stands for
  153.    the CD Type (MENUA=CARRS, etc.). Place the MENUx files in
  154.    the same directory as RomBrain.
  155.  
  156.                                                                      4.
  157.    ---------------------------------------------------------------------
  158.    MULTIPLE CD FILEBASE OPTION
  159.    ===========================
  160.    If you use more than one CD drive, you can use the SETUP to create
  161.    a set of data files for each.  Example:
  162.  
  163.    CARRS CD would have these files:
  164.  
  165.    CDTYPE_A.1    CDTYPE_A.2    CDTYPE_A.3   CDTYPE_A.4
  166.  
  167.    RBBS IN A BOX would have these:
  168.  
  169.    CDTYPE_C.1    CDTYPE_C.2    CDTYPE_C.3   CDTYPE_C.4 
  170.  
  171.    Setup will create a directory for each set of cdtype files, then copy
  172.    the files into the directory.  The directory name is the same as the
  173.    CDROM volume name.
  174.  
  175.    Next, you will need to let RomBrain know you have more than the single
  176.    filebase indicated by the initial setup. Create a file named DRIVE.DAT.
  177.  
  178.    The format for this file is:
  179.    CD VOLUME NAME,CDTYPE CODE,CD DRIVE LETTER,PATH TO CDTYPE FILES,LEVEL
  180.  
  181.    There should be one line of information for each CD. LEVEL is the level
  182.    required to access files on the CDROM listed on the line.
  183.    List the default CD on the first line - This is the CD you specified in
  184.    the SETUP program, when you first installed RomBrain.
  185.  
  186.    Example DRIVE.DAT file:
  187.  
  188.    CARRS #4,A,D:,C:\ROMBRAIN\PDSI_004,50
  189.    CARRS #5,A,E:,C:\ROMBRAIN\PDSI_005,50
  190.    RBBS IN A BOX,C,F:,C:\ROMBRAIN\RBBS,90
  191.  
  192.    Note: Use the comma to separate the information. If you use a comma
  193.          within the information like: CARRS, #4  errors will occur.
  194.          Include a colon with drive letter (Example E:).
  195. ----------------------------------------------------------------------------
  196.  
  197.    Once you have created your config file and filebase, you must then create
  198.    a batch file to run the door. A batch file for a GAP BBS looks like this:
  199.    
  200.      @ECHO OFF
  201.      SET DSZLOG=LOGx     <-------(Required for DSZ  x=Node Number)
  202.      CD \DOORS\ROMBRAIN   
  203.      ROMBRAIN RBRAIN1.CNF
  204.  
  205.    It is recommended but not required that you call RomBrain with the
  206.    config file's name on the command line. If you don't, RomBrain will
  207.    simply default to RBRAIN1.CNF.
  208.  
  209.                                                                      5.
  210.  
  211.  
  212.    You will also need to modify your doors menu files and the data
  213.    file that tells the BBS what your doors are and the security
  214.    level needed to access them. For GAP, these are respectively:
  215.    
  216.        DOORM
  217.        DOORMG
  218.        DOORS.DAT
  219.  
  220.    Please refer to your BBS documentation for details on 
  221.    setting up these files.
  222.  
  223.    If you are running multi-nodes, simply create a separate door
  224.    configuration file for each node, and number them. For instance,
  225.    for a 3 node system, you might have the following configuration
  226.    files:
  227.  
  228.        CDBRAIN1.CNF
  229.        CDBRAIN2.CNF
  230.        CDBRAIN3.CNF
  231.  
  232.    The only difference between the three would be the 1st line which
  233.    points to the default directory for the particular node.
  234.  
  235.    Another easy way to add the RomBrain to GAP is to use Gap's
  236.    configuration option to create a SYSOP DEFINED COMMAND (consult Gap's 
  237.    docs for info on sysop defined commands). On The Brainex System I use 
  238.    CDROM. The batch file to run RomBrain is named CDROM.BAT and placed 
  239.    in the BBS default directory (C:\GAP). When a caller types CDROM at the 
  240.    main prompt, they are instantly taken to the RomBrain.
  241.  
  242.    STARTUP/MENU SCREENS    
  243.    ====================
  244.    If you wish to bypass the welcome screen, rename or delete the
  245.    WELCOME and WELCOMEG files.  If you would like to use a different
  246.    menu screen, create your screen(s) and name them START for ASCII TEXT
  247.    and STARTG for ANSI menu screen.
  248.  
  249.    The following sysop functions are available while awaiting
  250.    keyboard input :
  251.  
  252.      F5      - Shell to DOS.
  253.      F8      - Twit user and return to BBS.
  254.     F10      - Initiate chat with user.
  255.     CF10     - Answer user page bell.
  256.     Home     - Main user stats.
  257.     End      - Displays sysop keys available.
  258.     PgDn     - Secondary user stats.
  259.     Up Arrow - Increase user's time remaining by 5 minutes.
  260.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  261.  
  262.                                                                      6.
  263.  
  264.  
  265.    One of the nicer features about using the TWIT key, is the user
  266.    is not told that "the sysop wants them to return to the BBS".
  267.    Instead, a very plain and simple message of "returning you to the
  268.    BBS" is displayed.  This way, the user is given no indication
  269.    that the sysop is hovering about.
  270.  
  271.    When using the F5 shell to DOS key, to return to the door
  272.    program, simply type EXIT at the DOS command prompt. It is not
  273.    necessary to change directories back to the door directory.
  274.    RomBrain is smart enough to know which drive and directory the
  275.    door program is in and will reset the defaults upon return from
  276.    DOS.
  277.  
  278.    The Up and Down Arrow keys increase and decrease the user's time
  279.    respectively by 5 minutes for each press of the key. There is no
  280.    indication of what is occurring (except by the fact the user's
  281.    time remaining will change), so the sysop should try not to have
  282.    a lead finger. The increase or decrease is effective only while
  283.    the user is in RomBrain.
  284.  
  285.    This version of RomBrain is a DEMO. File Transfers are disabled.
  286.    It will become full featured upon registration. This door is released
  287.    "As Is" and there is *NO* warranty or guarantee that it will work for
  288.    you and not cause any problems. You have chosen to use this door, YOU are 
  289.    responsible for any unfortunate problems that may develop from its 
  290.    use or misuse. I will gladly listen to any suggestions or 
  291.    problems you may have, and I will do my best to fix whatever 
  292.    needs to be fixed. I can not be held responsible for any problems 
  293.    you may have, whether directly or indirectly due to the use of the
  294.    door or its utilities or associated files.
  295.    
  296.    Please read REGISTER.DOC for information on how you can register
  297.    your copy of RomBrain. The download option will only work on
  298.    a registered version.
  299.  
  300.    For complete support, contact Stanley Sheff on The Brainex System.
  301.    Your questions will be quickly and cheerfully answered!
  302.  
  303.    NOTE-> If you have a CD not supported by RomBrain, a custom filebase
  304.           can be made for you by contacting me on Brainex.
  305.  
  306.    Have Fun!
  307.    Stanley Sheff
  308.    The Brainex System
  309.    310-275-2344 HST
  310.    310-273-5234 MNP
  311.  
  312.